Cream of the Crop 1

home *** CD-ROM | disk | FTP | other *** search

/ Cream of the Crop 1 / Cream of the Crop 1.iso / UTILITY / DTSEARCH.ARJ / DTSRCH.EXE / pak / README.DTS < prev next >

Wrap

Text File | 1991-11-14 | 16KB | 394 lines

November 14, 1991 d t S e a r c h 1.11 How to install dtSearch: * If you have the registered version, please follow the directions in the manual. * If you have the shareware version, there may be included an "INSTALL.EXE" file. This just creates a directory to hold the dtSearch program files and executes the self- extracting archive file DTSRCH.EXE. If you have INSTALL.EXE, you can use it to install dtSearch. If not, just unpack the files into a directory on your hard disk. dtSearch includes the following files: File Name Purpose of File: ------------ --------------------------------------------------- DTSEARCH.DOC Printable copy of the dtSearch manual DTSEARCH.EXE The dtSearch program DTSEARCH.HLP The hypertext help database for dtSearch DTSEARCH.MNU A menu data file for dtSearch DTS_SAFE.MNU An alternative menu data file for dtSearch DTSEARCH.NOI List of "noise" words for dtSearch DTSEARCH.REG A screen data file for dtSearch (registered version only) DTSEARCH.SCR A screen data file for dtSearch DESCRIBE.DTS Sample descriptions for catalogs, BBSs, etc. HISTORY.DTS dtSearch upgrade history LICENSE.DTS License and usage information ORDER.DTS Registration information and order form PACKING.DTS List of files included in dtSearch package README.DTS Important last-minute information SITELICE.DTS Site license information and agreement SYSOP.DTS Information for Bulletin Board System distribution (same as VENDOR.DTS) VENDOR.DTS Information and restrictions for disk vendors, distributors, user groups, etc. WARRANTY.DTS Important warranty information Upgrade Information From version 1.0... Document indexes and setup files created with dtSearch 1.0 will not work properly with version 1.11. Although version 1.11 can read indexes created with version 1.0, using version 1.11 to search for documents in an index created with version 1.0 may result in incorrect words being highlighted as "hits" when documents are retrieved. Therefore, if you are upgrading from version 1.0, you should - 2 - delete all of the version 1.0 files and indexes and reindex your documents. From version 1.1... Version 1.11 is fully compatible with version 1.1. All indexes and setup files will work as they did under version 1.1. You can upgrade to version 1.11 by simply installing the files from this version into your DTSEARCH directory. Do not delete the existing dtSearch 1.1 files. If you are a registered user of version 1.1, you do not have to register version 1.11. You can simply install the shareware version of dtSearch 1.11 in your DTSEARCH directory. The only difference between the shareware version of dtSearch and the registered version is the DTSEARCH.REG file, which suppresses the registration reminder screen. The DTSEARCH.REG file included in your dtSearch 1.1 package will work with version 1.11. Therefore, all you have to do to upgrade is to install the new version of dtSearch in your DTSEARCH directory. New Features in Version 1.11 A. DESQview Support Use the following DESQview parameters to run dtSearch in a DESQview window: Memory Size (in K): 384 Options: Writes text directly to screen.........: [N] Displays graphics information..........: [N] Virtualize text/graphics (Y,N,T).......: [Y] Uses serial ports (Y,N,1,2)............: [N] Requires floppy diskette...............: [N] B. Limited Access Menu dtSearch 1.11 includes a new, alternative menu file DTS_SAFE.MNU, which only allows users to perform indexed searches and view the results of searches. The purpose of the limited access menu is to provide a way for network administrators and bulletin-board operators to give their users simplified and limited access to document indexes. To run dtSearch using this menu, enter the command: DTSEARCH /MENU DTS_SAFE.MNU This menu will allow users to: (1) perform indexed searches; (2) view results of prior searches; (3) create search reports; (4) - 3 - select index libraries; and (5) print the contents of a window. Indexing features, the notepad editor, directory browsing, and unindexed searches are unavailable to a user running dtSearch with this menu. C. Batch Mode Indexing Batch mode indexing allows you to create, update, and compress a document index by running dtSearch from a batch file. (For information about creating batch files, see your DOS manual.) Batch mode indexing can be useful if, for example, you want to perform a complex and time-consuming series of tasks every night to update your indexes. 1. Overview To set up a batch indexing job, first create a "script" that lists the tasks that you want dtSearch to perform. A script is a text file that lists a series of indexing commands that dtSearch will carry out. The easiest way to create a script is to use the "Create Batch Script" option in the Index menu. When you select this option, a dialog box will appear that is almost identical to the "Update Index" dialog box. At the top of the box will be a line where you can specify the name of the script you want to create. Fill out the rest of the box exactly as you would if you were updating an index. If you want to create a new index for your batch job, use the "Create Index" section of the dialog box. See the manual section on Adding Documents to an Index for more information about the options in the Create Batch Script dialog box. When you are done setting up the indexing job, select the "Create Script" button at the bottom of the dialog box to create the batch script. dtSearch will then store all of the information you have provided (the index to update, the directories to index, etc.) in a script file that you can run later. To run the script that you created, exit dtSearch and type the following at the DOS prompt: DTSEARCH /SCRIPT MYSCRIPT.JOB where "MYSCRIPT.JOB" is the name of your script. dtSearch will then perform the indexing task you specified. dtSearch will record any errors encountered during the job in a file called MYSCRIPT.LOG. Errors will not be displayed on the screen, since dtSearch assumes that batch jobs will run without someone - 4 - watching them. After a batch indexing job, you should check the log file to see if any errors occured. This is all that you need to know to set up basic batch indexing tasks. The rest of this section provides information for more advanced use of batch mode indexing. 2. Script files A script file is any text file that dtSearch can read. You can create a script using the "Create Batch Script" option in the Index menu, or you can create a script by hand. Before you try to write your own scripts, you may want to create an example using the "Create Batch Script" function so you can see what a batch script looks like. A script can be ASCII text or it can be in one of the word processor formats that dtSearch recognizes, such as WordPerfect or WordStar. The first line of a script must consist of the words DTSEARCH SCRIPT. A script consists of a series of "SET" statements that specify the documents to be indexed and the index to use, and commands such as "ADD" and "COMPRESS". dtSearch ignores any line beginning with a *, so you can include comments in a script. Here is an example: DTSEARCH SCRIPT * Add documents from C:\DOCS to MyIndex SET INDEXNAME = MyIndex SET DOCPATH = C:\DOCS SET FILTER = *.DOC *.TXT *.WPF ADD COMPRESS This script would index documents in the directory C:\DOCS, storing information about the documents in the index called "MyIndex", and would compress the index. To run this script, put it in the file UPDATE.JOB and execute the command: DTSEARCH /SCRIPT UPDATE.JOB dtSearch will then execute the script, logging any error messages to the file UPDATE.LOG. 3. Creating an index To create an index, set up a script like this: SET INDEXNAME = MyIndex SET INDEXPATH = C:\DOCINDEX CREATE - 5 - The two SET statements tell the program what you want to call the index and the directory you want to put it into. The "CREATE" statement tells dtSearch to create the index in the specified directory. WARNING: Please be careful when using CREATE. If you create an index that already exists, dtSearch will delete the old index and create a new, empty index in its place. In interactive mode, you will get a warning message before this happens, but in batch mode dtSearch simply assumes that you really want to create a new index. 4. Adding documents to an index To add documents to an index, use "SET DOCPATH =" to tell dtSearch the directory in which the documents are located and "SET FILTERS =" to specify the file name filters. Then use the "ADD" command to add the documents to the index. If you want to index documents in several directories, use multiple "SET DOCPATH =" statements separated by "ADD" commands. Example: SET INDEXNAME = MyIndex SET DOCPATH = C:\DOCS SET FILTER = *.DOC *.TXT *.WPF ADD SET DOCPATH = C:\DOCS2 ADD SET DOCPATH = C:\DOCS3 ADD This would add documents from C:\DOCS, c:\DOCS2, and c:\DOCS3 to the index "MyIndex". The CREATE function needs to know both the name and the directory for an index, and so both the SET INDEXNAME and the SET INDEXPATH must be present to create an index. The ADD function just needs to know which index you want to add documents to, so you can use either the name (SET INDEXNAME) or the path (SET INDEXPATH) to specify the index. 5. Reindexing changed documents The REINDEX command in a script will cause dtSearch to reindex any documents in an index that have been modified since the index was last updated. This is the batch mode equivalent to the "Reindex changed documents" menu option. Example: SET INDEXNAME = MyIndex REINDEX - 6 - 6. Compressing an index To compress an index, use SET INDEXNAME or SET INDEXPATH to specify the index to compress and then use the COMPRESS command. Example: SET INDEXNAME = MyIndex COMPRESS 7. Complex scripts A script can do more than one indexing task. For example, this script would create the index MyIndex, add documents to it, compress it, and then create a second index: SET INDEXNAME = MyIndex SET INDEXPATH = c:\myindex CREATE SET DOCPATH = c:\docs SET FILTERS = *.doc *.wpf *.txt ADD COMPRESS SET INDEXNAME = MyIndex II SET INDEXPATH = c:\myindex2 CREATE Note that you do not need to specify the index name again after the CREATE command. dtSearch will remember the values given for the previous command until you change them. 8. Running a script To run a script, enter the command DTSEARCH /SCRIPT name substituting the name of the script you want to run for "name". 9. Errors Any errors that occur during a batch indexing job are logged to a file with the same name as the script file but with the extension ".LOG". For example, if you ran a script called UPDATE.JOB, the log will be in UPDATE.LOG. - 7 - For each line in the script, the log file will contain the text of the line with >> in front of it. Any errors caused by a statement will follow this line. Here is an example. Suppose that EXAMPLE.JOB contains the following script, with an error in the last line ("COMPRESS" is misspelled): SET INDEXNAME = MyIndex SET INDEXPATH = c:\myindex CREATE SET DOCPATH = c:\docs SET FILTER = *.doc ADD COMRPESS To run this script, you would enter the command DTSEARCH /SCRIPT EXAMPLE.JOB After indexing is done, this is what the EXAMPLE.LOG file would look like: ----------------------------------------------------------- Executing script file EXAMPLE.JOB Starting Time: 7:00pm Mon 4 Nov 91 ----------------------------------------------------------- >> SET INDEXNAME = MyIndex >> SET INDEXPATH = c:\myindex >> CREATE Creating index: MyIndex c:\myindex >> SET DOCPATH = c:\docs >> SET FILTER = *.doc >> ADD Adding documents to index Index: MyIndex c:\myindex Filters: *.doc Directory: c:\docs Indexing complete >> COMRPESS Unrecognized script command. Execution complete. Time: 7:10pm Mon 4 Nov 91 The error message, "Unrecognized script command," follows the misspelled command "COMRPESS".